home *** CD-ROM | disk | FTP | other *** search
/ Aminet 40 / Aminet 40 (2000)(Schatztruhe)[!][Dec 2000].iso / Aminet / dev / gui / MR_Classes.lha / MR_Classes / Dev / Source / palette / palette.doc < prev    next >
Encoding:
Text File  |  2000-09-04  |  3.9 KB  |  143 lines
  1. /****** palette.requester/--datasheet-- ******************************************
  2. *
  3. *   NAME
  4. *       palette.requester -- Requester for editing a color palette
  5. *
  6. *   REQUIRES
  7. *       supermodel.class
  8. *       tcpalette.gadget
  9. *       Reaction gadgets
  10. *
  11. *   METHODS
  12. *       OM_NEW - creatres new requester object.
  13. *         Only available through PREQ_NewRequester()
  14. *
  15. *       OM_DISPOSE - dispose requester.
  16. *         Only available through PREQ_DisposeRequester()
  17. *
  18. *       OM_SET -
  19. *
  20. *       OM_GET - 
  21. *
  22. *       RM_DOREQUEST - open requester
  23. *
  24. *       RM_DOREQUESTASYNC - unimplemented
  25. *
  26. *   ATTRIBUTES
  27. *       PR_Screen - Screen to open requester on.
  28. *       (OM_NEW, OM_SET)
  29. *       
  30. *       PR_Window - Parent Window
  31. *       (OM_NEW, OM_SET)
  32. *
  33. *       PR_PubScreenName - Public Screen Name
  34. *       (OM_NEW, OM_SET)
  35. *
  36. *       PR_Colors - Number of colors to edit 1..256
  37. *       (OM_NEW, OM_SET)
  38. *
  39. *       PR_Palette - Palette to edit, must be at least 
  40. *         PR_Colors entries in the array of struct prRGB.
  41. *         When you get this attribute, you must supply a buffer
  42. *         with enough memory to hold and PR_Colors size array of 
  43. *         struct prRGB
  44. *       (OM_NEW, OM_SET, OM_GET)
  45. *
  46. *       PR_TextAttr - TextAttr of gadget Text.
  47. *       (OM_SET)
  48. *
  49. *       PR_TitleText - Text of window
  50. *       (OM_NEW, OM_SET)
  51. *
  52. *       PR_PositiveText - "Ok"
  53. *       (OM_NEW, OM_SET)
  54. *
  55. *       PR_NegativeText - "Cancel"
  56. *       (OM_NEW, OM_SET)
  57. *
  58. *       PR_InitialTopEdge,LeftEdge,Width,Height - Initial values for window. 
  59. *         not implemented.
  60. *       (OM_NEW, OM_SET)
  61. *
  62. *       PR_Red/Green/BlueBits - Bits per component. not implemented. 
  63. *
  64. *   RESULT
  65. *
  66. *   EXAMPLE
  67. *
  68. *   NOTES
  69. *       While this requester keeps 32bit per component (RGB), due to limitations
  70. *       of the slider gadget, edits only 8bits per component, only 256 levels.  
  71. *       Future versions may fix this.
  72. *
  73. *   BUGS
  74. *       Bad things will happen if you OM_GET PR_Palette with an array that 
  75. *       doesn't have atleast PR_Colors entries.
  76. *
  77. *       The Undo gadget won't disable on the first pen edited.
  78. *
  79. *   SEE ALSO
  80. *
  81. ******************************************************************************
  82. *
  83. */
  84.  
  85. /****** palette.requester/PREQ_NewRequester ******************************************
  86. *
  87. *   NAME
  88. *       PREQ_NewRequester -- Allocate a new Palette requester.
  89. *
  90. *   SYNOPSIS
  91. *       Object = PREQ_NewRequester(Tags,...)
  92. *
  93. *       Object *PREQ_NewRequester(Tag, ...);
  94. *       a0                        a0
  95. *
  96. *       Object *PREQ_NewRequesterA(struct TagItem *)
  97. *       a0                                a0
  98. *
  99. *   FUNCTION
  100. *       Allocates a new Palette requester object.
  101. *       The palette requester is a BOOPSI object.
  102. *       Further settings can be changed or read
  103. *       with SetAttrs() or GetAttr().
  104. *
  105. *
  106. *   SEE ALSO
  107. *       palette.requester/--datasheet--
  108. *
  109. ******************************************************************************
  110. *
  111. */
  112.  
  113. /****** palette.requester/PREQ_DisposeRequester ******************************************
  114. *
  115. *   NAME
  116. *       PREQ_DisposeRequester -- Dispose palette requester.
  117. *
  118. ******************************************************************************
  119. *
  120. */
  121.  
  122. /****** palette.requester/--history-- ******************************************
  123. *
  124. *   To Do -
  125. *       * Maybe cause requester to notify other object WHILE open?
  126. *       * Menu's to load/save, and a "Preset" menu
  127. *       * Create pop-up gadget class (similar to GetScreenMode etc.)
  128. *
  129. *   44.1 - 
  130. *       * OM_GET wasn't handled in the dispatcher.
  131. *       * Getting PR_Palette now works - requester was kinda useless before.
  132. *       * Setting PR_Screen, Window, PubScreenName will center the requester
  133. *   44.2 - 
  134. *       * Included version string
  135. *   44.3 -
  136. *       * All source files needed to be recompiled for 44.2, but were not.
  137. *       * If you cancel the gadget, and then OM_GET PR_Palette, you will get
  138. *         a copy of the initial palette
  139. *
  140. ******************************************************************************
  141. *
  142. */
  143.